Skip to content

Update from code changes: document editor version history - #6872

Merged
ethanpalm merged 15 commits into
mainfrom
mintlify/editor-version-history-docs
Aug 14, 2026
Merged

Update from code changes: document editor version history#6872
ethanpalm merged 15 commits into
mainfrom
mintlify/editor-version-history-docs

Conversation

@mintlify

@mintlify mintlify Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

Summary

Documents the editor version history and restore features introduced in mintlify/mint#9783, mintlify/mint#9787, and mintlify/server#7263.

Changes

  • Adds workflow steps and explains the saved-version details shown in the editor.
  • Clarifies page and branch scope, pagination, and version recording behavior.
  • Documents restoring older versions, confirmation, permission requirements, blocked deploy branches, and unsaved-change replacement.
  • Documents private-page version history, cross-branch sharing, comparison access, and restore permissions.
  • Covers the feature in English, Spanish, French, and Chinese.
  • Applies a documentation best-practices pass for translation parity, readability, links, metadata, and formatting.

Medium Risk
Documentation-only changes to MDX guides. The documented restore action replaces current page content and can overwrite unsaved edits.

Overview
Documents the editor version history feature across English, Spanish, French, and Chinese editor/pages.mdx guides.

Adds a Version history section (after diff view in EN/ES/FR; after Markdown mode in ZH) covering how to open it via More options → Version history, what each saved entry shows (author, relative time, Latest), scope (public pages use the current branch; private pages share history across branches), Show more versions pagination, the docs.json exclusion, and the restore workflow for older versions.

Users with permission to edit a page can select Restore on an older version and confirm the action. Restore replaces the current page content, including unsaved changes. Viewers can review and compare saved versions of private pages. Editors and managers can restore them. Restore is unavailable on blocked deploy branches and the Latest version. Users can compare versions from the drawer and select the active version again to exit comparison.

Frontmatter keywords now include version history; the Chinese page also gets a focused description covering version history alongside other page-editing topics.

Reviewed by Cursor Bugbot for commit 82db3dc. Bugbot is set up for automated code reviews on this repo. Configure here.

Update history

  • Added the saved-version recording behavior introduced in mintlify/server#7138: Mint records entries when saved content differs from the latest version, skips unchanged duplicates, and supports empty saved pages.
  • Added the editor history restore workflow introduced in mintlify/mint#9787: authorized editors can confirm restoring older versions, which replaces current content and unsaved changes.
  • Added backend restore support introduced in mintlify/server#7200: restoring a version applies the selected snapshot to the current page within the current site, deployment, and branch.
  • Added version comparison introduced in mintlify/mint#9869: selecting an older saved version opens a diff against the current page content, and selecting it again exits comparison.
  • Added private-page version history introduced in mintlify/server#7263: viewers can review and compare shared versions across branches, while editors and managers can restore them.

Note

Low Risk
Documentation-only MDX updates with no runtime or security impact; they describe a destructive restore workflow for readers.

Overview
Adds Version history documentation to the editor pages guides in English, Spanish, French, and Chinese, placed after diff view (EN/ES/FR) or after Markdown mode (ZH).

The new section explains how saved versions are recorded (new entry only when content differs; no duplicate on unchanged saves; empty pages allowed), how entries are grouped and labeled (Current), and that docs.json is excluded. It documents opening history via More options → Version history and the Edited timestamp when supported.

It clarifies scope: public page history is limited to the current branch; private page history spans all branches, with Show more versions for older entries. Restore is available on older versions for users with edit permission (editors/managers on private pages); it replaces current content including unsaved changes, with different behavior for public vs private pages. Restore is unavailable on blocked deploy branches and the Current entry. Selecting a row opens diff view against the current page; clicking the active row again exits comparison.

Frontmatter keywords now include version history; the Chinese page also gets an expanded description covering version history alongside other editing topics.

Reviewed by Cursor Bugbot for commit 8024f71. Bugbot is set up for automated code reviews on this repo. Configure here.

@mintlify

mintlify Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview Aug 5, 2026, 1:18 AM

@mintlify

mintlify Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
tomee 🟢 Ready View Preview Aug 5, 2026, 1:18 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@mintlify

mintlify Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor Author

Update from code changes updated this PR.

Updated Chinese editor page description for SEO compliance

Source PRs

@mintlify

mintlify Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor Author

Update from code changes updated this PR.

Added paragraph breaks to improve version history readability across four localized guides

Source PRs

@mintlify

mintlify Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor Author

Update from code changes updated this PR.

Refined restore-scope wording across four localized editor pages

Source PRs

@mintlify

mintlify Bot commented Aug 6, 2026

Copy link
Copy Markdown
Contributor Author

Update from code changes updated this PR.

Added no new documentation; completed a best-practices audit

Source PRs

@mintlify

mintlify Bot commented Aug 12, 2026

Copy link
Copy Markdown
Contributor Author

Update from code changes updated this PR.

Added no new documentation changes

Source PRs

@mintlify

mintlify Bot commented Aug 14, 2026

Copy link
Copy Markdown
Contributor Author

Update from code changes updated this PR.

Added no documentation changes

Source PRs

@ethanpalm
ethanpalm merged commit 839f44c into main Aug 14, 2026
6 checks passed
@ethanpalm
ethanpalm deleted the mintlify/editor-version-history-docs branch August 14, 2026 23:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants